<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>SystemSharp: SystemSharp.Collections.PriorityQueue&lt; T &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">SystemSharp
   &#160;<span id="projectnumber">0.3</span>
   </div>
   <div id="projectbrief">A system-level modeling framework for designing real-time embedded systems</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Events</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SystemSharp.Collections.PriorityQueue&lt; T &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A priority queue implementation which resolves collisions (i.e. multiple elements for same key) using a user-defined resolution function.  
 <a href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acb551706055f1bf3c9dfae750bdedd2b"><td class="memItemLeft" align="right" valign="top">delegate T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html#acb551706055f1bf3c9dfae750bdedd2b">ResolveFunc</a> (T v1, T v2)</td></tr>
<tr class="memdesc:acb551706055f1bf3c9dfae750bdedd2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolution function delegate  <a href="#acb551706055f1bf3c9dfae750bdedd2b">More...</a><br/></td></tr>
<tr class="separator:acb551706055f1bf3c9dfae750bdedd2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93fbc7fed575239db6c254b5c8d4a8dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html#a93fbc7fed575239db6c254b5c8d4a8dd">Enqueue</a> (long key, T value)</td></tr>
<tr class="memdesc:a93fbc7fed575239db6c254b5c8d4a8dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inserts element <em>value</em>  for specified <em>key</em> . Lower key means higher priority.  <a href="#a93fbc7fed575239db6c254b5c8d4a8dd">More...</a><br/></td></tr>
<tr class="separator:a93fbc7fed575239db6c254b5c8d4a8dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91e4dcb4ad3f749e62eca1c17e35b975"><td class="memItemLeft" align="right" valign="top">KeyValuePair&lt; long, T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html#a91e4dcb4ad3f749e62eca1c17e35b975">Dequeue</a> ()</td></tr>
<tr class="memdesc:a91e4dcb4ad3f749e62eca1c17e35b975"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes and returns the element with highest priority, i.e. lowest key.  <a href="#a91e4dcb4ad3f749e62eca1c17e35b975">More...</a><br/></td></tr>
<tr class="separator:a91e4dcb4ad3f749e62eca1c17e35b975"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa355badcc9d947a5494a3206381610a7"><td class="memItemLeft" align="right" valign="top">KeyValuePair&lt; long, T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html#aa355badcc9d947a5494a3206381610a7">Peek</a> ()</td></tr>
<tr class="memdesc:aa355badcc9d947a5494a3206381610a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the element with highest priority, i.e. lowest key, but does not remove it.  <a href="#aa355badcc9d947a5494a3206381610a7">More...</a><br/></td></tr>
<tr class="separator:aa355badcc9d947a5494a3206381610a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a06fe599c6fff3e41635efaf291d74957"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html#acb551706055f1bf3c9dfae750bdedd2b">ResolveFunc</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html#a06fe599c6fff3e41635efaf291d74957">Resolve</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a06fe599c6fff3e41635efaf291d74957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolution function which is called in case of an element being inserted for an existing key. It is mandatory to set this property to a non-null value when there is a possibility of key collisions.  <a href="#a06fe599c6fff3e41635efaf291d74957">More...</a><br/></td></tr>
<tr class="separator:a06fe599c6fff3e41635efaf291d74957"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a539376a66991c8e0cc9cf1395c79a304"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html#a539376a66991c8e0cc9cf1395c79a304">IsEmpty</a><code> [get]</code></td></tr>
<tr class="memdesc:a539376a66991c8e0cc9cf1395c79a304"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether queue contains any element.  <a href="#a539376a66991c8e0cc9cf1395c79a304">More...</a><br/></td></tr>
<tr class="separator:a539376a66991c8e0cc9cf1395c79a304"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A priority queue implementation which resolves collisions (i.e. multiple elements for same key) using a user-defined resolution function. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>datatype of priority queue element</td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_priority_queue_8cs_source.html#l00033">33</a> of file <a class="el" href="_priority_queue_8cs_source.html">PriorityQueue.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a91e4dcb4ad3f749e62eca1c17e35b975"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KeyValuePair&lt;long, T&gt; SystemSharp.Collections.PriorityQueue&lt; T &gt;.Dequeue </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Removes and returns the element with highest priority, i.e. lowest key. </p>

<p>Definition at line <a class="el" href="_priority_queue_8cs_source.html#l00113">113</a> of file <a class="el" href="_priority_queue_8cs_source.html">PriorityQueue.cs</a>.</p>

</div>
</div>
<a class="anchor" id="a93fbc7fed575239db6c254b5c8d4a8dd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SystemSharp.Collections.PriorityQueue&lt; T &gt;.Enqueue </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Inserts element <em>value</em>  for specified <em>key</em> . Lower key means higher priority. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>key for which to insert the value</td></tr>
    <tr><td class="paramname">value</td><td>element to insert</td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_priority_queue_8cs_source.html#l00101">101</a> of file <a class="el" href="_priority_queue_8cs_source.html">PriorityQueue.cs</a>.</p>

</div>
</div>
<a class="anchor" id="aa355badcc9d947a5494a3206381610a7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KeyValuePair&lt;long, T&gt; SystemSharp.Collections.PriorityQueue&lt; T &gt;.Peek </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the element with highest priority, i.e. lowest key, but does not remove it. </p>

<p>Definition at line <a class="el" href="_priority_queue_8cs_source.html#l00141">141</a> of file <a class="el" href="_priority_queue_8cs_source.html">PriorityQueue.cs</a>.</p>

</div>
</div>
<a class="anchor" id="acb551706055f1bf3c9dfae750bdedd2b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">delegate T SystemSharp.Collections.PriorityQueue&lt; T &gt;.ResolveFunc </td>
          <td>(</td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>v1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">T&#160;</td>
          <td class="paramname"><em>v2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Resolution function delegate </p>
<p>Depending on your use case, there are multiple possibilities of implementing a resolution function. The most simple and stupid option is to either keep the existing element (return <em>v1</em> ) or to replace the existing element by the new one (return <em>v2</em> ). A more advanced approach is to specify some collection or set type, e.g. a HashSet, and to construct the set-union of both parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">v1</td><td>an element</td></tr>
    <tr><td class="paramname">v2</td><td>another element</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>some element representing the union of both elements</dd></dl>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a539376a66991c8e0cc9cf1395c79a304"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool SystemSharp.Collections.PriorityQueue&lt; T &gt;.IsEmpty</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Whether queue contains any element. </p>

<p>Definition at line <a class="el" href="_priority_queue_8cs_source.html#l00161">161</a> of file <a class="el" href="_priority_queue_8cs_source.html">PriorityQueue.cs</a>.</p>

</div>
</div>
<a class="anchor" id="a06fe599c6fff3e41635efaf291d74957"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html#acb551706055f1bf3c9dfae750bdedd2b">ResolveFunc</a> SystemSharp.Collections.PriorityQueue&lt; T &gt;.Resolve</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Resolution function which is called in case of an element being inserted for an existing key. It is mandatory to set this property to a non-null value when there is a possibility of key collisions. </p>

<p>Definition at line <a class="el" href="_priority_queue_8cs_source.html#l00067">67</a> of file <a class="el" href="_priority_queue_8cs_source.html">PriorityQueue.cs</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_priority_queue_8cs_source.html">PriorityQueue.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespace_system_sharp.html">SystemSharp</a></li><li class="navelem"><a class="el" href="namespace_system_sharp_1_1_collections.html">Collections</a></li><li class="navelem"><a class="el" href="class_system_sharp_1_1_collections_1_1_priority_queue_3_01_t_01_4.html">PriorityQueue< T ></a></li>
    <li class="footer">Generated on Thu Dec 26 2013 14:21:58 for SystemSharp by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
